Skip to main content

ARDK for Android/com.nianticlabs.ardk/ScannerConfig/useArdkDepthsIfPlatformUnavailable

useArdkDepthsIfPlatformUnavailable

[androidJvm]
var useArdkDepthsIfPlatformUnavailable: Boolean

Whether to use and record NSDK's estimated depths, if platform depths are unavailable.

Depths are recorded as part of the scan data, and are also required to generate voxels or raycast visualization images. If NSDK was configured to use platform depths, this value is ignored, and depths are expected to come through the scanning session. Otherwise:

  • When true, NSDK will generate estimated depths for use by the scanning feature
  • When false, the scanning feature will not be able to generate voxels or raycast visualization images, but will still be able to record other scan data.

Attention: If NSDK depth is being recorded because useArdkDepthsIfPlatformUnavailable is true and lidar is unavailable, the recording FPS will be limited to the update rate of the depth feature, which defaults to 10 FPS. To change the update rate of the depth feature, set DepthConfig.framerate to match framerate.

Default:false